<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: transport/struc/msg.hpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_58e412aa7ace8e71fc01678dc8765e7c.html">transport</a></li><li class="navelem"><a class="el" href="dir_a98fddea045b8b2df4350ebb1d483bf8.html">struc</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">msg.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="transport__fwd_8hpp_source.html">ipc/transport/transport_fwd.hpp</a>&quot;</code><br />
<code>#include &quot;ipc/transport/struc/schema/detail/structured_msg.capnp.h&quot;</code><br />
<code>#include &quot;<a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2error_8hpp_source.html">ipc/transport/struc/error.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="asio__local__stream__socket__fwd_8hpp_source.html">ipc/transport/asio_local_stream_socket_fwd.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="native__handle_8hpp_source.html">ipc/util/native_handle.hpp</a>&quot;</code><br />
<code>#include &lt;boost/endian.hpp&gt;</code><br />
<code>#include &lt;boost/move/make_unique.hpp&gt;</code><br />
</div>
<p><a href="msg_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__out.html">ipc::transport::struc::Msg_out&lt; Message_body, Struct_builder_t &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A structured out-message suitable to be sent via <a class="el" href="classipc_1_1transport_1_1struc_1_1Channel.html#ae645cb58ad9ea6374970f1f32c5da448" title="In the synchronous/non-blocking manner of Blob_sender::send_blob() or Native_handle_sender::send_nati...">struc::Channel::send()</a> (et al).  <a href="classipc_1_1transport_1_1struc_1_1Msg__out.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__in.html">ipc::transport::struc::Msg_in&lt; Message_body, Struct_reader_config &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A structured in-message <em>instance</em> suitable as received and emittable (to user) by <a class="el" href="classipc_1_1transport_1_1struc_1_1Channel.html" title="Owning and wrapping a pre-connected transport::Channel peer (an endpoint of an established channel ov...">struc::Channel</a>.  <a href="classipc_1_1transport_1_1struc_1_1Msg__in.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceipc"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc.html">ipc</a></td></tr>
<tr class="memdesc:namespaceipc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Catch-all namespace for the Flow-IPC project: A library/API in modern C++17 providing high-performance communication between processes. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceipc_1_1transport"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport.html">ipc::transport</a></td></tr>
<tr class="memdesc:namespaceipc_1_1transport"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) between pairs of processes. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceipc_1_1transport_1_1struc"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1struc.html">ipc::transport::struc</a></td></tr>
<tr class="memdesc:namespaceipc_1_1transport_1_1struc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sub-module of Flow-IPC module <a class="el" href="namespaceipc_1_1transport.html" title="Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...">ipc::transport</a> providing transmission of structured messages specifically. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a0052ea1afda1ed94e008805d40264c20"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="msg_8hpp.html#a0052ea1afda1ed94e008805d40264c20">TEMPLATE_STRUCT_MSG_OUT</a>&#160;&#160;&#160;  template&lt;typename Message_body, typename Struct_builder_t&gt;</td></tr>
<tr class="memdesc:a0052ea1afda1ed94e008805d40264c20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internally used macro; public API users should disregard (same deal as in <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp.html">struc/channel.hpp</a>).  <a href="msg_8hpp.html#a0052ea1afda1ed94e008805d40264c20">More...</a><br /></td></tr>
<tr class="separator:a0052ea1afda1ed94e008805d40264c20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8ab263935b3bae1c9ee6355a55fa94a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="msg_8hpp.html#af8ab263935b3bae1c9ee6355a55fa94a">CLASS_STRUCT_MSG_OUT</a>&#160;&#160;&#160;  Msg_out&lt;Message_body, Struct_builder_t&gt;</td></tr>
<tr class="memdesc:af8ab263935b3bae1c9ee6355a55fa94a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internally used macro; public API users should disregard (same deal as in <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp.html">struc/channel.hpp</a>).  <a href="msg_8hpp.html#af8ab263935b3bae1c9ee6355a55fa94a">More...</a><br /></td></tr>
<tr class="separator:af8ab263935b3bae1c9ee6355a55fa94a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af03d0377672ffdd140776914e4b98872"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="msg_8hpp.html#af03d0377672ffdd140776914e4b98872">TEMPLATE_STRUCT_MSG_IN</a>&#160;&#160;&#160;  template&lt;typename Message_body, typename Struct_reader_config&gt;</td></tr>
<tr class="memdesc:af03d0377672ffdd140776914e4b98872"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internally used macro; public API users should disregard (same deal as in <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp.html">struc/channel.hpp</a>).  <a href="msg_8hpp.html#af03d0377672ffdd140776914e4b98872">More...</a><br /></td></tr>
<tr class="separator:af03d0377672ffdd140776914e4b98872"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a679f25e8d9dc9d3ad750442e92b640f0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="msg_8hpp.html#a679f25e8d9dc9d3ad750442e92b640f0">CLASS_STRUCT_MSG_IN</a>&#160;&#160;&#160;  Msg_in&lt;Message_body, Struct_reader_config&gt;</td></tr>
<tr class="memdesc:a679f25e8d9dc9d3ad750442e92b640f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internally used macro; public API users should disregard (same deal as in <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp.html">struc/channel.hpp</a>).  <a href="msg_8hpp.html#a679f25e8d9dc9d3ad750442e92b640f0">More...</a><br /></td></tr>
<tr class="separator:a679f25e8d9dc9d3ad750442e92b640f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a134e737e55ae825527efd6a9e68bf37e"><td class="memTemplParams" colspan="2">template&lt;typename Message_body , typename Struct_builder_t &gt; </td></tr>
<tr class="memitem:a134e737e55ae825527efd6a9e68bf37e"><td class="memTemplItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1struc.html#a134e737e55ae825527efd6a9e68bf37e">ipc::transport::struc::operator&lt;&lt;</a> (std::ostream &amp;os, const Msg_out&lt; Message_body, Struct_builder_t &gt; &amp;val)</td></tr>
<tr class="memdesc:a134e737e55ae825527efd6a9e68bf37e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints string representation of the given <code><a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__out.html" title="A structured out-message suitable to be sent via struc::Channel::send() (et al).">Msg_out</a></code> to the given <code>ostream</code>.  <a href="namespaceipc_1_1transport_1_1struc.html#a134e737e55ae825527efd6a9e68bf37e">More...</a><br /></td></tr>
<tr class="separator:a134e737e55ae825527efd6a9e68bf37e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad52996a4d66f74e21e4f2e74c93c763"><td class="memTemplParams" colspan="2">template&lt;typename Message_body , typename Struct_reader_config &gt; </td></tr>
<tr class="memitem:aad52996a4d66f74e21e4f2e74c93c763"><td class="memTemplItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1struc.html#aad52996a4d66f74e21e4f2e74c93c763">ipc::transport::struc::operator&lt;&lt;</a> (std::ostream &amp;os, const Msg_in&lt; Message_body, Struct_reader_config &gt; &amp;val)</td></tr>
<tr class="memdesc:aad52996a4d66f74e21e4f2e74c93c763"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints string representation of the given <code><a class="el" href="classipc_1_1transport_1_1struc_1_1Msg__in.html" title="A structured in-message instance suitable as received and emittable (to user) by struc::Channel.">Msg_in</a></code> to the given <code>ostream</code>.  <a href="namespaceipc_1_1transport_1_1struc.html#aad52996a4d66f74e21e4f2e74c93c763">More...</a><br /></td></tr>
<tr class="separator:aad52996a4d66f74e21e4f2e74c93c763"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a679f25e8d9dc9d3ad750442e92b640f0" name="a679f25e8d9dc9d3ad750442e92b640f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a679f25e8d9dc9d3ad750442e92b640f0">&#9670;&nbsp;</a></span>CLASS_STRUCT_MSG_IN</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CLASS_STRUCT_MSG_IN&#160;&#160;&#160;  Msg_in&lt;Message_body, Struct_reader_config&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Internally used macro; public API users should disregard (same deal as in <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp.html">struc/channel.hpp</a>). </p>

<p class="definition">Definition at line <a class="el" href="msg_8hpp_source.html#l00861">861</a> of file <a class="el" href="msg_8hpp_source.html">msg.hpp</a>.</p>

</div>
</div>
<a id="af8ab263935b3bae1c9ee6355a55fa94a" name="af8ab263935b3bae1c9ee6355a55fa94a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8ab263935b3bae1c9ee6355a55fa94a">&#9670;&nbsp;</a></span>CLASS_STRUCT_MSG_OUT</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CLASS_STRUCT_MSG_OUT&#160;&#160;&#160;  Msg_out&lt;Message_body, Struct_builder_t&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Internally used macro; public API users should disregard (same deal as in <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp.html">struc/channel.hpp</a>). </p>

<p class="definition">Definition at line <a class="el" href="msg_8hpp_source.html#l00855">855</a> of file <a class="el" href="msg_8hpp_source.html">msg.hpp</a>.</p>

</div>
</div>
<a id="af03d0377672ffdd140776914e4b98872" name="af03d0377672ffdd140776914e4b98872"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af03d0377672ffdd140776914e4b98872">&#9670;&nbsp;</a></span>TEMPLATE_STRUCT_MSG_IN</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TEMPLATE_STRUCT_MSG_IN&#160;&#160;&#160;  template&lt;typename Message_body, typename Struct_reader_config&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Internally used macro; public API users should disregard (same deal as in <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp.html">struc/channel.hpp</a>). </p>

<p class="definition">Definition at line <a class="el" href="msg_8hpp_source.html#l00858">858</a> of file <a class="el" href="msg_8hpp_source.html">msg.hpp</a>.</p>

</div>
</div>
<a id="a0052ea1afda1ed94e008805d40264c20" name="a0052ea1afda1ed94e008805d40264c20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0052ea1afda1ed94e008805d40264c20">&#9670;&nbsp;</a></span>TEMPLATE_STRUCT_MSG_OUT</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TEMPLATE_STRUCT_MSG_OUT&#160;&#160;&#160;  template&lt;typename Message_body, typename Struct_builder_t&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Internally used macro; public API users should disregard (same deal as in <a class="el" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp.html">struc/channel.hpp</a>). </p>

<p class="definition">Definition at line <a class="el" href="msg_8hpp_source.html#l00852">852</a> of file <a class="el" href="msg_8hpp_source.html">msg.hpp</a>.</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
